ci-info
Advanced tools
Package description
The ci-info npm package provides information about the Continuous Integration (CI) environment that your code is running in. It can detect if the current environment is a CI server and provide details about which one it is. This is useful for adjusting the behavior of your application or scripts based on whether they are being run in a CI environment or not.
Detecting CI environment
This feature allows you to check if your code is running in a CI environment. The property 'isCI' will be true if it is, or false otherwise.
const ci = require('ci-info');
if (ci.isCI) {
console.log('The code is running in a CI environment.');
} else {
console.log('This is not a CI environment.');
}Identifying specific CI service
This feature allows you to check for specific CI services. Each supported CI service has a corresponding property that will be true if the code is running on that service.
const ci = require('ci-info');
if (ci.TRAVIS) {
console.log('The code is running on Travis CI.');
}Getting CI service name
This feature allows you to retrieve the name of the CI service that the code is running on, if it is running in a CI environment.
const ci = require('ci-info');
if (ci.isCI) {
console.log(`The CI service name is ${ci.name}`);
}Similar to ci-info, is-ci is a simple package that allows you to detect if your code is running in a CI environment. However, it does not provide detailed information about which CI service is being used.
env-ci is another package that provides information about the CI environment. It offers similar functionality to ci-info, but also includes additional metadata such as branch name, build number, and commit information.
Changelog
v1.6.0
Readme
Get details about the current Continuous Integration environment.
Please open an issue if your CI server isn't properly detected :)
npm install ci-info --save
var ci = require('ci-info')
if (ci.isCI) {
console.log('The name of the CI server is:', ci.name)
} else {
console.log('This program is not running on a CI server')
}
Officially supported CI servers:
| Name | Constant |
|---|---|
| AWS CodeBuild | ci.CODEBUILD |
| AppVeyor | ci.APPVEYOR |
| Bamboo by Atlassian | ci.BAMBOO |
| Bitbucket Pipelines | ci.BITBUCKET |
| Bitrise | ci.BITRISE |
| Buddy | ci.BUDDY |
| Buildkite | ci.BUILDKITE |
| CircleCI | ci.CIRCLE |
| Cirrus CI | ci.CIRRUS |
| Codeship | ci.CODESHIP |
| Drone | ci.DRONE |
| dsari | ci.DSARI |
| GitLab CI | ci.GITLAB |
| GoCD | ci.GOCD |
| Hudson | ci.HUDSON |
| Jenkins CI | ci.JENKINS |
| Magnum CI | ci.MAGNUM |
| Sail CI | ci.SAIL |
| Semaphore | ci.SEMAPHORE |
| Shippable | ci.SHIPPABLE |
| Solano CI | ci.SOLANO |
| Strider CD | ci.STRIDER |
| TaskCluster | ci.TASKCLUSTER |
| Team Foundation Server by Microsoft | ci.TFS |
| TeamCity by JetBrains | ci.TEAMCITY |
| Travis CI | ci.TRAVIS |
ci.nameA string. Will contain the name of the CI server the code is running on.
If not CI server is detected, it will be null.
Don't depend on the value of this string not to change for a specific
vendor. If you find your self writing ci.name === 'Travis CI', you
most likely want to use ci.TRAVIS instead.
ci.isCIA boolean. Will be true if the code is running on a CI server.
Otherwise false.
Some CI servers not listed here might still trigger the ci.isCI
boolean to be set to true if they use certain vendor neutral
environment variables. In those cases ci.name will be null and no
vendor specific boolean will be set to true.
ci.isPRA boolean if PR detection is supported for the current CI server. Will
be true if a PR is being tested. Otherwise false. If PR detection is
not supported for the current CI server, the value will be null.
ci.<VENDOR-CONSTANT>A vendor specific boolean constants is exposed for each support CI
vendor. A constant will be true if the code is determined to run on
the given CI server. Otherwise false.
Examples of vendor constants are ci.TRAVIS or ci.APPVEYOR. For a
complete list, see the support table above.
Deprecated vendor constants that will be removed in the next major release:
ci.TDDIUM (Solano CI) This have been renamed ci.SOLANOFAQs
Get details about the current Continuous Integration environment
We found that ci-info demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.